<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>robotide.action.actioninfo.ActionInfo</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="robotide-module.html">Package&nbsp;robotide</a> ::
        <a href="robotide.action-module.html">Package&nbsp;action</a> ::
        <a href="robotide.action.actioninfo-module.html">Module&nbsp;actioninfo</a> ::
        Class&nbsp;ActionInfo
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ActionInfo</h1><p class="nomargin-top"><span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#ActionInfo">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+    
         |    
  <a href="robotide.action.actioninfo.MenuInfo-class.html">MenuInfo</a> --+
             |
            <strong class="uidshort">ActionInfo</strong>
</pre>

<hr />
Used to create menu entries, keyboard shortcuts and/or toolbar buttons.

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.action.actioninfo.ActionInfo-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">menu_name</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">action</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">container</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">shortcut</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">icon</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">doc</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Initializes information needed to create actions..</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#ActionInfo.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.action.actioninfo.MenuInfo-class.html#is_separator" class="summary-sig-name">is_separator</a>(<span class="summary-sig-arg">self</span>)</span>
      <em>(Inherited from <a href="robotide.action.actioninfo.MenuInfo-class.html">robotide.action.actioninfo.MenuInfo</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#MenuInfo.is_separator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="robotide.action.actioninfo.MenuInfo-class.html#set_menu_position" class="summary-sig-name">set_menu_position</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">before</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">after</span>=<span class="summary-sig-default">None</span>)</span><br />
      Sets the position of this menu entry.
      <em>(Inherited from <a href="robotide.action.actioninfo.MenuInfo-class.html">robotide.action.actioninfo.MenuInfo</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#MenuInfo.set_menu_position">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">menu_name</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">action</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">container</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">shortcut</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">icon</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">doc</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="robotide.action.actioninfo-pysrc.html#ActionInfo.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initializes information needed to create actions..</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>menu_name</code></strong> - The name of the menu where the new entry will be added. The menu is
created if it does not exist.</li>
        <li><strong class="pname"><code>name</code></strong> - The name of the new menu entry. The name may contain an accelerator
key prefixed by an ampersand like <tt class="rst-docutils literal">New &amp;Action</tt>. If an accelerator
is not specified, or the one requested is already taken, the next
free key is selected.</li>
        <li><strong class="pname"><code>action</code></strong> - The callable which will be called when a user does any of the
associated UI actions.</li>
        <li><strong class="pname"><code>container</code></strong> - The wxPython element containing the UI components associated with
the <tt class="rst-docutils literal">action</tt>. When any of the registered UI actions is executed,
the <tt class="rst-docutils literal">action</tt> is called only if the <tt class="rst-docutils literal">container</tt> or any of its
child components has focus. It is possible to make the <tt class="rst-docutils literal">action</tt>
always active by using <tt class="rst-docutils literal">None</tt> as the <tt class="rst-docutils literal">container</tt>.</li>
        <li><strong class="pname"><code>shortcut</code></strong> - The keyboard shortcut associated to the <tt class="rst-docutils literal">action</tt>. The <tt class="rst-docutils literal">shortcut</tt>
must be a string constructed from optional modifiers (<tt class="rst-docutils literal">Ctrl, Shift,
Alt</tt>) and the actual shortcut key separating the parts with a hyphen.
The shortcut key can be either a single character or any of the
<a class="rst-reference external" href="http://docs.wxwidgets.org/stable/wx_keycodes.html#keycodes" target="_top">wx keycodes</a> without the <tt class="rst-docutils literal">WXK_</tt> prefix. Examples: <tt class="rst-docutils literal"><span class="pre">Ctrl-C</span></tt>,
<tt class="rst-docutils literal"><span class="pre">Shift-Ctrl-6</span></tt>, <tt class="rst-docutils literal"><span class="pre">Alt-Left</span></tt>, <tt class="rst-docutils literal">F6</tt>.</li>
        <li><strong class="pname"><code>icon</code></strong> - The icon added to the toolbar as a toolbar button. It can be either
a 16x16 bitmap or a string presenting one of the icons provided by
<a class="rst-reference external" href="http://www.wxpython.org/docs/api/wx.ArtProvider-class.html" target="_top">wxPython's ArtProvider</a> like <tt class="rst-docutils literal">ART_FILE_OPEN</tt>.</li>
        <li><strong class="pname"><code>doc</code></strong> - The documentation shown on the statusbar when selection is on
the associated menu entry or toolbar button.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="robotide-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/robotframework-ride">RIDE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Apr 13 15:09:37 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
